/*$$
 * Copyright (c) 1999, Trustees of the University of Chicago
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with 
 * or without modification, are permitted provided that the following 
 * conditions are met:
 *
 *	 Redistributions of source code must retain the above copyright notice,
 *	 this list of conditions and the following disclaimer.
 *
 *	 Redistributions in binary form must reproduce the above copyright notice,
 *	 this list of conditions and the following disclaimer in the documentation
 *	 and/or other materials provided with the distribution.
 *
 * Neither the name of the University of Chicago nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE TRUSTEES OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *$$*/
package uchicago.src.sim.engine;

import java.util.Vector;

public class ListIncrementer implements Incrementer {

  private int index = 0;
  private Vector list;
  private Object curVal = null;

  public ListIncrementer(Vector v) {
    list = v;
    curVal = list.get(0);
  }

  public boolean increment() {
    boolean retVal = true;
    if (index < list.size() - 1) {
      index++;
      curVal = list.get(index);
    } else {
      // reset to starting parameter
      // necessary if this is a sub parameter.
      index = 0;
      curVal = list.get(0);
      retVal = false;
    }

    return retVal;
  }

  public String getStringValue() {
    return curVal.toString();
  }

  public boolean isConstant() {
    return false;
  }

  public String getValAsParameterSet() {
    Object object = list.get(index);
    if (object instanceof Number) {
      return "set: " + object.toString();
    } else if (object instanceof String) {
      return "set_string: " + object;
    } else if (object instanceof Boolean) {
      return "set_boolean: " + object.toString();
    }
    return null;
  }

	/**
	 * @return
	 * @see uchicago.src.sim.engine.Incrementer#getValue()
	 */
	public Object getValue() {
	    return curVal;
	}
}

